Type Definitions

The following type definitions are available globally.

  • Provides both the old and new versions of an object in this Realm. Object properties can only be accessed using keyed subscripting.

    Declaration

    Objective‑C

    typedef void (^RLMObjectMigrationBlock)(RLMObject *_Nullable,
                                        RLMObject *_Nullable)

    Swift

    typealias RLMObjectMigrationBlock = (RLMObject?, RLMObject?) -> Void

    Parameters

    oldObject

    Object in original RLMRealm (read-only).
    newObject

    Object in migrated RLMRealm (read-write).
    Show on GitHub

  • Block to run when the data in a Realm was modified.

    Declaration

    Objective‑C

    typedef void (^RLMNotificationBlock)(NSString *_Nonnull, RLMRealm *_Nonnull)

    Swift

    typealias RLMNotificationBlock = (String, RLMRealm) -> Void
    Show on GitHub

  • Migration block used to migrate a Realm.

    Declaration

    Objective‑C

    typedef void (^RLMMigrationBlock)(RLMMigration *_Nonnull, uint64_t)

    Swift

    typealias RLMMigrationBlock = (RLMMigration, UInt64) -> Void

    Parameters

    migration

    RLMMigration object used to perform the migration. The migration object allows you to enumerate and alter any existing objects which require migration.
    oldSchemaVersion

    The schema version of the RLMRealm being migrated.
    Show on GitHub